Docs/issue 29 intro claude md#30
Conversation
…ment Provide structured guidance for e.g. Claue Code including project structure development commands, architecture overview, and MCP adapter behavioral principles.
timdauer
requested review from
Copilot,
j-shao1,
joshfischer-cin7 and
kelly-goetsch
There was a problem hiding this comment.
Pull request overview
Adds repository-level Claude Code guidance and a backend capability-manifest template, plus adjusts NPM publishing configuration to ensure scoped package releases are public.
Changes:
- Add root
CLAUDE.mdwith repo architecture, principles, and development commands. - Introduce
backends/documentation and a starter capability manifest for a backend integration. - Configure NPM publishing as public (via
publishConfigand CI publish command).
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
server/package.json |
Adds publishConfig.access=public for scoped NPM publishing defaults. |
backends/your-backend/CAPABILITIES.md |
Adds a backend capability manifest template for tool usage and error-doc links. |
backends/README.md |
Documents expected structure and process for adding backend manifests. |
CLAUDE.md |
Adds repo-wide Claude Code guidance, principles, and a backend integrations table. |
.github/workflows/release.yml |
Publishes to NPM with --access public during tagged releases. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 3 out of 4 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ## Canonical Tool List | ||
|
|
||
| These operations define the full surface area of the MCP specification for this backend integration. |
There was a problem hiding this comment.
The manifest claims this tool list is the "full surface area" of the MCP specification, but later notes say additional action/query methods may be implemented in the future. This is internally inconsistent and may confuse readers—either rephrase to "current"/"initial" surface area or remove the "additional methods" notes.
| These operations define the full surface area of the MCP specification for this backend integration. | |
| These operations define the current canonical surface area of the MCP specification for this backend integration. |
| | Operation | Error Reference | | ||
| |-----------|-----------------| | ||
| | Create order | [Link to error documentation] | |
There was a problem hiding this comment.
The Markdown table under "Error Documentation" uses double leading pipes (||), which renders as an extra empty column on GitHub. Use standard table syntax with a single leading pipe for each row so the table formats correctly.
|
|
||
| - **getOrders(input)** | ||
| Maps to: `GET /api/orders/:id` | ||
| Retrieves order details. |
There was a problem hiding this comment.
getOrders reads like a collection query, but the documented endpoint mapping is GET /api/orders/:id (single-order). Consider aligning these (e.g., adjust the endpoint to a collection route or clarify in the description that this method expects an identifier and returns a single order) to avoid ambiguity in the capability manifest.
| Retrieves order details. | |
| Retrieves details for a single order identified by the ID provided in the input. |
Provide structured guidance for e.g. Claue Code including project structure development commands, architecture overview, and MCP adapter behavioral principles.